Skip to main content

ข้อความ Commit แบบ Semantic ยกระดับทักษะการเขียนโปรแกรมของคุณ

· 2 min read

ข้อความ Commit แบบ Semantic: ยกระดับทักษะการเขียนโปรแกรมของคุณ

เคยไหม? เวลาต้องย้อนกลับไปดู commit เก่า ๆ รู้สึกสับสน อ่านแล้วไม่เข้าใจว่า commit นั้น ๆ เปลี่ยนแปลงอะไรไปบ้าง ปัญหานี้สามารถแก้ไขได้ง่าย ๆ เพียงแค่เปลี่ยนรูปแบบการเขียนข้อความ commit ให้เป็นแบบ Semantic Commit Messages

Semantic Commit Messages คืออะไร?

Semantic Commit Messages คือรูปแบบการเขียนข้อความ commit ที่มีความชัดเจน กระชับ สื่อความหมายได้ครบถ้วน ประกอบไปด้วย 3 ส่วนหลัก ดังนี้

  • ประเภทของการเปลี่ยนแปลง (type): ระบุประเภทของการเปลี่ยนแปลง ตัวอย่างประเภทที่นิยมใช้ เช่น
info
  • feat: เพิ่มฟีเจอร์ใหม่สำหรับผู้ใช้
  • fix: แก้ไขข้อบกพร่องสำหรับผู้ใช้
  • docs: อัปเดตเอกสาร
  • style: ปรับแต่งรูปแบบโค้ด
  • refactor: ปรับโครงสร้างโค้ด
  • test: เพิ่มหรือแก้ไขโค้ดทดสอบ
  • chore: อัปเดตงานอื่น ๆ ที่ไม่เกี่ยวกับโค้ด product
  • ขอบเขต (scope): ระบุส่วนที่ได้รับผลกระทบจากการเปลี่ยนแปลง (ไม่จำเป็นต้องระบุ)

  • หัวข้อ (subject): อธิบายหัวข้อหลักของการเปลี่ยนแปลง

ตัวอย่าง

info
  • feat: เพิ่มปุ่ม "บันทึก"
  • fix: แก้ไขข้อผิดพลาดในการแสดงผลรูปภาพ
  • docs: อัปเดตเอกสารประกอบ API
  • style: ปรับแต่ง format ของโค้ด
  • refactor: เปลี่ยนชื่อตัวแปร count เป็น total
  • test: เพิ่มการทดสอบสำหรับฟีเจอร์ใหม่
  • chore: อัปเดตสคริปต์ build

ข้อดีของการใช้ Semantic Commit Messages

tip
  • อ่านเข้าใจง่าย: ข้อความ commit ที่มีความชัดเจน กระชับ ช่วยให้เข้าใจเนื้อหาได้ง่าย โดยไม่ต้องเสียเวลาตีความ
  • ติดตามการเปลี่ยนแปลง: ง่ายต่อการติดตามว่ามีการเปลี่ยนแปลงอะไรเกิดขึ้นบ้างใน project
  • ค้นหาข้อมูล: ค้นหา commit ที่ต้องการได้อย่างสะดวกรวดเร็ว
  • ทำงานร่วมกัน: ช่วยให้การทำงานร่วมกันเป็นทีมราบรื่นขึ้น สมาชิกในทีมสามารถเข้าใจการเปลี่ยนแปลงของผู้อื่นได้ง่าย

การเริ่มต้นใช้งาน Semantic Commit Messages

การเริ่มต้นใช้งาน Semantic Commit Messages นั้นง่ายมาก เพียงแค่ทำตามขั้นตอนดังนี้

  • เลือกประเภทของการเปลี่ยนแปลง
  • ระบุขอบเขต (ถ้ามี)
  • เขียนหัวข้อที่อธิบายเนื้อหาการเปลี่ยนแปลง

ตัวอย่างเพิ่มเติม

info
  • feat(profile): เพิ่มฟีเจอร์แก้ไขข้อมูลส่วนตัว
  • fix(login): แก้ไขข้อผิดพลาดในการเข้าสู่ระบบ
  • docs(api): อัปเดตเอกสารประกอบ API เกี่ยวกับการชำระเงิน
  • style(components): ปรับแต่ง format ของโค้ดใน component
  • refactor(utils): เปลี่ยนชื่อฟังก์ชัน calculateTotal เป็น computeSum
  • test(features): เพิ่มการทดสอบสำหรับฟีเจอร์ใหม่
  • chore(deps): อัปเดตเวอร์ชันของ library ที่ใช้

แหล่งข้อมูล

tip

การใช้ Semantic Commit Messages เป็นวิธีง่าย ๆ ที่ช่วยยกระดับทักษะการเขียนโปรแกรมของคุณ ช่วยให้การทำงานร่วมกันเป็นทีมราบรื่นขึ้น และช่วยให้ติดตามการเปลี่ยนแปลงต่าง ๆ ใน project ได้อย่างมีประสิทธิภาพ

ลองนำ Semantic Commit Messages ไปใช้กับ project ของคุณ เริ่มต้นวันนี้!